Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

give more explicit pointer to the contribute guide #29909

Merged
merged 1 commit into from
Jan 30, 2023
Merged

give more explicit pointer to the contribute guide #29909

merged 1 commit into from
Jan 30, 2023

Conversation

maxandersen
Copy link
Member

I would prefer the relevant mvn commands to use/run was documented in the repo rather than "off-site" but with this there is at least a chance to discover the documentation.

@maxandersen
Copy link
Member Author

relates to #29907

@quarkus-bot
Copy link

quarkus-bot bot commented Dec 16, 2022

Thanks for your pull request!

The title of your pull request does not follow our editorial rules. Could you have a look?

  • title should preferably start with an uppercase character (if it makes sense!)

This message is automatically generated by a bot.

@quarkus-bot

This comment has been minimized.

Sign in to view
@ebullient
Copy link
Member

Just add an additional sentence or direct link to the adoc file that is in the same directory...

The pretty version is rendered on the web.. but the adoc is perfectly readable and is right there...

ebullient
ebullient reviewed Dec 16, 2022
View reviewed changes
docs/README.md Outdated Show resolved Hide resolved
@maxandersen
Copy link
Member Author

Just add an additional sentence or direct link to the adoc file that is in the same directory...

The pretty version is rendered on the web.. but the adoc is perfectly readable and is right there...

which adoc file? the docs folder has no such file.

@ebullient
Copy link
Member

See the suggested edits. All of those files exist in docs/src/asciidoc.

@maxandersen
Copy link
Member Author

See the suggested edits. All of those files exist in docs/src/asciidoc.

ok, so not the same folder. docs != docs/src/asciidoc :)

@maxandersen
Copy link
Member Author

push update that points out the nested readme.adoc to avoid duplication and broken links.

@ebullient
Copy link
Member

squash please.

@inoxx03
Copy link

inoxx03 commented Dec 21, 2022

@maxandersen thank you for the update. I spotted some typos and dropped in edit suggestions to fix. Other than that, LGTM.

inoxx03
inoxx03 approved these changes Dec 21, 2022
View reviewed changes
Copy link

@inoxx03 inoxx03 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added some phrasing suggestions, too. Feel free to accept/decline them as you see fit, but please fix the typos:)

docs/README.md Outdated Show resolved Hide resolved
docs/README.md Outdated Show resolved Hide resolved
gsmet
gsmet approved these changes Jan 30, 2023
View reviewed changes
Copy link
Member

@gsmet gsmet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Squashed and tuned some additional things.

@gsmet gsmet merged commit c942136 into quarkusio:main Jan 30, 2023
@quarkus-bot quarkus-bot bot added this to the 2.17 - main milestone Jan 30, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@inoxx03 inoxx03 inoxx03 approved these changes

@gsmet gsmet gsmet approved these changes

@ebullient ebullient ebullient approved these changes

Assignees
No one assigned
Labels
area/documentation
Projects
None yet
Milestone
3.0.0.Alpha4
Development

Successfully merging this pull request may close these issues.
4 participants
@maxandersen @ebullient @inoxx03 @gsmet